Show:

Streams html Class

Defined in: platform/plugins/Streams/handlers/Streams/html/tool.php:7
Module: Streams-tools

Inline editor for HTML content

Constructor

Streams html

(
  • [$options]
)

Defined in platform/plugins/Streams/handlers/Streams/html/tool.php:7

Parameters:

  • [$options] Array optional

    this array contains function parameters

    • publisherId String

      The publisher's user id.

    • field String

      The name of the stream field used to save the html.

    • [streamName] String optional

      If empty, and "creatable" is true, then this can be used to add new related streams.

    • [placeholder] String optional

      The placeholder HTML

    • [editor="auto"] String optional

      Can be "ckeditor", "froala", "basic" or "auto".

    • [editable] Boolean optional

      Set to false to avoid showing even authorized users an interface to replace the contents

    • [ckeditor] Array optional

      The config, if any, to pass to ckeditor

    • [froala] Array optional

      The config, if any, to pass to froala

    • [preprocess] String optional

      Name of an optional function which takes [callback, tool] and calls callback(objectToExtendAnyStreamFields)

Item Index